package de.dopichaj.labrador.index.backend;

public final class TermFrequency implements Comparable<TermFrequency> {
    private final int termID;
    private final int documentID;
    private final int frequency;
    
    public TermFrequency(final int termID, final int documentID,
        final int frequency) {
        
        this.termID = termID;
        this.documentID = documentID;
        this.frequency = frequency;
    }
    
    public int getTermID() {
        return termID;
    }

    public int getDocumentID() {
        return documentID;
    }

    public int getFrequency() {
        return frequency;
    }

    public int compareTo(TermFrequency o) {
        if (o.getTermID() < getTermID()) {
            return 1;
        } else if (o.getTermID() > getTermID()) {
            return -1;
        } else {
            if (o.getDocumentID() < getDocumentID()) {
                return 1;
            } else if (o.getDocumentID() > getDocumentID()) {
                return -1;
            } else {
                return 0;
            }
        }
    }

    @Override
    public int hashCode() {
        final int PRIME = 31;
        int result = 1;
        result = PRIME * result + documentID;
        result = PRIME * result + termID;
        return result;
    }

    @Override
    public boolean equals(Object obj) {
        if (this == obj)
            return true;
        if (obj == null)
            return false;
        if (getClass() != obj.getClass())
            return false;
        final TermFrequency other = (TermFrequency)obj;
        if (documentID != other.documentID)
            return false;
        if (termID != other.termID)
            return false;
        return true;
    }
    
    @Override
    public String toString() {
        return "<" + getTermID() + ", " + getDocumentID() + ", " +
            getFrequency() + ">";
    }
}
/*
Copyright (c) 2007 Philipp Dopichaj

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in
all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
THE SOFTWARE.
*/